Beispiele zu Artikeln
Bei Artikeln handelt es sich um die Shop Produkte. Diese können über die API abgefragt, geändert und gelöscht werden.
Welche Felder im einzelnen bei Artikeln zur Verfügung stehen, kann am Besten in der API Testumgebung getestet werden. Diese verfügt über eine kontextgesteuerte Dokumentation und ist immer an den aktuellen Entwicklungsstand angepasst.
Eine Dokumentation dazu finden Sie auch im Artikel Typen.
{warning} Die brshop24 API hat den Status "Work in progress". Bei dieser Dokumentation handelt sich um einen Vorabzug zu Testzwecken.
Query: Artikel
Eine einfache Anfrage der Shop Artikel kann wie folgt formuliert werden:
query ArtikelListe {
articles {
total
from
to
data {
id
article_number
partner_display_name
}
}
}Diese Abfrage liefert im Ergebnis eine Liste von Artikeln. Da keine limitierung der Anzahl angegeben ist, werden die die ersten 10 Artikel ermittelt.
Jeder Artikel soll mit dem Wert für die id, article_number und partner_display_name zur Verfügung gestellt werden.
Query: Artikel by id
Möchten Sie einen bestimmten Artikel ermitteln, kann dieser über eine "where" Bedingung ermittelt werden.
Dabei wird der eindeutige Bezeichner "id" verwendent:
query ArtikelListe {
articles (where: {id: 10}) {
data {
id
article_number
partner_display_name
}
}
}Query: Artikel mit Pagination
query ArtikelSeitenweise {
articles(page: {per_page: 40, number: 2}) {
total
from
to
per_page
current_page
data {
id
article_number
partner_display_name
}
}
}